BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / doors_1 / ktfm_213.zip / KTFLEA.DOC < prev next >

Wrap

Text File | 1993-01-06 | 25KB | 605 lines

KT-FleaMarket v2.13 Copyright(c) 1992 by Kelsey Technologies All Rights Reserved. --------------------------------- Kelsey Technologies P.O. Box 288 St. Mary's, GA 31558 Phone: (912) 882-0533 BBS: (912) 882-3588 DESCRIPTION ----------- KT-FleaMarket is a BBS Door program which will provide your users with a complete, full featured Advertisement System. KT-FleaMarket will support unlimited categories, up to 1 billion Ads, Non-standard Ports including the DigiBoard MC/X and PC/X Multi-Port Adapters, DOOR.SYS, DORINFOx.DEF, PCBOARD.SYS and High Speed Modems. With the registered version you can even 'Rename' Kt-FleaMarket to something that is more suitable to your specific situation. You can attach files to the ads which the users can download using Zmodem, Ymodem, Ymodem-G, Xmodem, & Xmodem-1k (without the need for DSZ). You can also allow your users to attach files from remote using the same protocols. Other options include the ability to allow your users to either place new ads or just view them. You can toggle a validation flag which prevents all new ads from being automatically released until reviewed by you. The AlwaysShow option provides a means to 'Highlight' one or more ads which will ALWAYS be displayed to the users regardless of category. There are many features built-in which allow you to 'Rent Space' on your classified ads system, or simply make it a free service to your users. KT-FleaMarket v2.13ß uses Real-Time File and Record Locking to provide the safest multi-user environment available which can theoretically support an unlimited number of concurrent users. UPGRADING FROM A PREVIOUS VERSION --------------------------------- | PLEASE PRINT THE README.1ST FILE FOR DETAILED INSTRUCTIONS | BEFORE PERFORMING THE UPGRADE TO VERSION 2.13ß! SETUP: ------ SETUP UTILITY: -------------- The Setup Utility allows you to create an unlimited number of configurations which can be called from your BBS based on the type of access you wish to give that particular user. TYPE: KTFLEA SETUP First the Setup Utility will try to gain an exclusive control of the database (used primarily in multi-user systems). If an exclusive Lock can be obtained, you are asked to enter a Configuration File Name. You may create any number of different config files for use as you see fit. Enter a Config File Name to continue. Next you will be asked a series of questions, each with a full explanation. I'll not go into too much detail here as the system takes care of it for me. When you're done with the Setup Utility, you'll be returned to DOS. NOTE: The last configuration file you created will also be copied to a file called LOCAL.CFG. This is used in Local Mode only and provides a way for you to test out your various configurations. Remember, the LOCAL.CFG file will always be the same as the Last Configuration file you created. Why create different Config Files? Well, this way, you can essentially create multiple doors without multiple copies of the program or databases. Sound reasonable? CATEGORIES: ----------- In the file KTFLEA.CAT you'll find some examples of Categories Similar to those you'd find in the local newspaper (and a few of my own). ╔════════════════════════════════════════════════════════════╗ ║ NOTES: THE FIRST LINE MUST ALWAYS BE: ALL CATEGORIES;ALL ║ ║ ║ ║ DON'T PUT ANY OTHER TEXT OR NOTES IN THE CATEGORY ║ ║ FILE EXCEPT YOUR CATEGORIES. ║ ╚════════════════════════════════════════════════════════════╝ The structure of this file goes like this: Category Description;CATEGORY NAME The Category Description may be up to 65 characters and the CATEGORY NAME may be up to 20 characters with a semi-colon (;) as a separator (can you say that three times real fast?). Local BBS Ads;LOCAL BBS ADS Garage Sales;GARAGE SALE Dog, Cat, Bird, and Mouse Grooming;PET GROOMING Get the idea? The CATEGORY NAME must be in all CAPS. Don't put any spaces between the Description, the Semi-Colon, and the Name. ADDING/DELETING CATEGORIES: ---------------------------- Feel free to use your favorite editor to sort this listing of Categories. Makes for a better presentation to the user. If you wish to REMOVE a Category from the list, ensure you've deleted all Ads under that Category from the Database First (or use the KTFMEditor which is described below). If you don't delete the ads associated with the removed category, those ads will still be displayed when the user has selected ALL CATEGORIES. If you want to ADD a Category, you don't need to do a thing except put it in the KTFLEA.CAT file. KT-FleaMarket will take care of everything else. | ATTACHED FILES: (Configured with the Setup Utility) | --------------------------------------------------- | There are two ways to go about this. First, you can allow your | users to UPLOAD an attached file that goes with the ad. Or, Two, | you can allow them to DOWNLOAD only. If you choose the second of | the two, you will have to manually attach a file to the ad using | KTFMEditor. This is really a much better way of going about things | if you think about it. This way, you don't have to worry about | getting a bunch of duplicate files in another directory and better | yet, you don't have to worry about virus's etc. I recommend the | second method. | | I have mine setup to allow users to Download files but not upload | them. I have the Download path set to my regular Download path | used with the BBS. This way, I don't have two copies of the same | file floating around. The only ads that have attached files are | the ones for my DOORS and they are also available from within the | BBS this way (without two copies). | | I'm thinking of removing the UPLOAD option altogether. I've not | heard of anyone actually using it for the reasons I've mentioned | above. The download option however, can be very useful. Please | provide feedback on what you want. SYNTAX ('The Command Line') ------------------------- Basic Command Line: KTFLEA <bbstype> <userfile> <comfile> <configfile> After an explaination of each of the options, I'll tell you how to put them all together. <bbstype> --------- Is the BBS Software you are using. This command goes hand-in-hand with the <userfile> command. Valid <bbstype> commands are: WILDCAT, RBBS, & PCBOARD. By selecting one of the above <bbstype> commands doesn't restrict you to using these particular BBS Programs. They are simply a means of telling KT-FleaMarket how to read the <userfile>. <userfile> ---------- Is the file created by your BBS which tells KT-FleaMarket about the current user. Again, this command goes hand-in-hand with the <bbstype> command. Valid <userfile> commands are: DOOR.SYS, PCBOARD.SYS, AUNTIE.SYS, & DORINFOx.DEF The files go together like this: -------------------------------- WILDCAT - DOOR.SYS RBBS - DORINFOx.DEF AUNTIE - PCBOARD.SYS (AUNTIE.SYS) PCBOARD - PCBOARD.SYS So, to further explain this 'merge', If your BBS can create a DOOR.SYS file, then you'd use the WILDCAT command. If your BBS can create a PCBOARD.SYS, then you'd use the PCBOARD command. It's pretty straight forward. | <comfile> | --------- | QuikStart: If you used the CTSRTS switch in version 2.0x, I've | included a <comfile> to get you going immediatly (KTFMNODE.001). | Take a look at this file AFTER you read COMSETUP.DOC. | | | If any of the following is true in your case, you'll need to read | the file COMSETUP.DOC | | o Using a High Speed Modem (2400/MNP or 9600+). | o Using Non-Standard Com Ports. | o Using Non-Standard IRQ's. | o Using a DigiBoard PC/X or MC/X multi-port serial card. | ! SEE BETATEST.DOC for info on FREE REGISTRATION ! | o Have a 16450 UART or wish to enable FIFO (if you're not | sure about this one, take a look at the COMSETUP.DOC | file anyway, and determine your needs from there) | | If any of the above is NOT true in your case, don't bother with the | COMSETUP.DOC file, just use the KTFMNODE.001 file I've provided. | | If you require a <comfile>, and your BBS can create a DOOR.SYS, | and you want all new ads validated, the command would be: | | KTFLEA WILDCAT C:\BBS\NODE1\DOOR.SYS KTFMNODE.xxx VALIDATE | | If you don't want new ads validated, the same command would be: | | KTFLEA WILDCAT C:\BBS\NODE1\DOOR.SYS KTFMNODE.xxx | | NOTE: If you put your <comfile> in a directory other than the | KT-FleaMarket directory, you'll need to specify a path. I don't see | the value in placing them in different paths since they should all | be different names (i.e. NODE.001, NODE.002, etc.). You are free to | name these <comfile>s anything you're comfortable with. | <configfile> | ------------ | Is the file you created using the Setup Utility. This <configfile> | tells KT-FleaMarket how you want it's various options to perform. | SAMPLE BATCH FILE | ----------------- | | @ECHO OFF | CD\BBS\DOORS\KTFLEA | KTFLEA WILDCAT C:\BBS\NODE1\DOOR.SYS KTFMNODE.001 KTCONFIG.001 | CD\BBS\NODE1 | CAT Get the idea? KTFLEA <bbsfile> <userfile> <comfile> <configfile> USERHELP.TXT ------------ The file USERHELP.TXT may be edited as you wish. This file provides help to the user while using the DOOR. You may also wish to place this file in a download area so your users can read up on how the system works. KT-FleaMarket was designed with the most Novice Users in mind. They shouldn't need much help. OPENING.TXT ----------- This file can contain a 'new name' for KT-FleaMarket. I've had more than a few people tell me that the name KT-FleaMarket isn't very professional (in a business atmosphere), and they wanted the name changed. So, now everyone can do it. Create a file called OPENING.TXT in the KT-FleaMarket directory. Line #1 should contain the 'new name', but please don't exceed about 25 characters. Lines #2-5 should contain an opening 'welcome' message to the users. Don't exceed about 58 characters on these lines. Now, on every prompt where it used to say KT-FleaMarket, it will present the users with Your 'new name'. Please Note: This feature only works in Local Mode on Unregistered Copies. Please find a file called OPEN.TXT. This is an example. MAINTENANCE (LOCAL MODE) ------------------------ There really isn't much maintenance involved with this system. It pretty much takes care of itself. However (always a however), if you've enabled the VALIDATION option, you'll need to Validate the Un-Validated Ads (does that make any sense? I didn't think so). LOCAL MODE: ----------- To run KT-FleaMarket in Local Mode, type: KTFLEA LOCAL Be sure to run the SETUP utility first though (KTFLEA SETUP). TO VALIDATE ADS: ---------------- A few quick notes about Validating Ads and Local Mode... While viewing Ads in the Detail Mode, there are several options available (as seen on the last line in the display). One of these Options is (V)alidate, but it's hidden. This (V)alidate Option 'Toggles' the Validation Status of that particular Ad. You can tell whether the Ad is Validated or Not by the words "Validated" or "!! NOT VALIDATED !!", which appear right under the Category Name. This "Validation Status" is only visible while in Local Mode. To Validate Ads, start KT-FleaMarket in the local mode (KTFLEA LOCAL) and Select ALL CATEGORIES. When the Main Menu appears, you'll notice an additional option in Blue called [V]alidate Ads (this only appears in Local Mode). Selecting the Option [V]alidate Ads will filter out ALL Ads which are marked as !!! NOT VALIDATED !!! (it will NOT automatically Validate Ads for you). At this point, you would select the Option, [L]ist Ads (Detail), and step through each "Un-Validated" Ad, changing the "Validation Status" as you see fit. You may toggle the Validation of an ad at any time by pressing (V) while in the Detail Screens. This probably sounds confusing but it's really quite easy as you'll see when you try it. TO AlwaysShow ADS ----------------- This feature toggles the AlwaysShow option. Just like the (V)alidate option, you can use the (A)lways option to toggle the AlwaysShow status of a particular ad. If ON, the AlwaysShow option makes that Ad 'Global'. Meaning it will ALWAYS be displayed to your users regarless what category they may have selected. This is handy if you really want to push one (or several) ads to your users. You could also charge more for this feature if you're renting ad space on your system. You can tell if an ad is set to AlwaysShow by the words Always Display=ON or Always Display=OFF right under the Category name and next to the Validation Status Indicator. Again, this option is ONLY available in Local Mode. privileges... ------------- Being SysOp has it's privileges. While using KT-FleaMarket in Local Mode, the options (E)dit and (K)ill will always be available in the Detail Screens. While running as a DOOR, these options will ONLY be available to the user who placed it. That way, Joe can't mess with Bob's Ads. Who is Joe and Bob anyway? The hidden options (V)alidate and (A)lwaysShow will be available at all times while in Local Mode also. Please see KTFMEditor later in this document. Automatic Purge --------------- After time, Ads become obsolete. Either the person moved, the item sold, or a hurricane destroyed it. Regardless, the users will be lazy and probably won't delete their old Ads. Not to fear! You can put out in a bulletin or in the USERHELP.TXT file that all ads over 120 days will be removed. Now, make a monthly event (or weekly, or daily, or hourly, or minutely if you want) to purge Ads over 120 days. The Purge will ONLY affect Ads which are NOT marked as AlwaysShow and are Validated. If you want to keep certain ads in the database for future use, simply Un-Validate them. KTFLEA PURGE 120 Simply replace the 120 above with what ever number of days old you wish to remove. NOTE: If anyone is using the system on another node, the Purge Command will wait up to 10 Seconds to get an Exclusive Lock on the Database. If Exclusive Control can't be had, the purge will not take place. Just a little safety feature. To remove ALL ads over the Purge Value, use the command: KTFLEA PURGE 120 ALL This will remove ALL ads over 120 days regardless if they are Validated or Not. | NOTE: I've tested this feature up to 9666 days old. Removing Deleted Ads: --------------------- Well, OK, some of your users may actually delete their ads when they no longer apply. If this is the case, run the PACK command on a regular basis to remove these deleted records. The command is: KTFLEA PACK This command is useful if you don't have a need to ever Purge the Database. They both do the same thing, as far as removing Deleted Records. If you use the Purge Command, the Pack Command is unnecessary. NOTE: If anyone is using the system on another node, the Pack Command will wait up to 10 Seconds to get an Exclusive Lock on the Database. If Exclusive Control can't be had, the Pack will not take place. Just another little safety feature. | THE CLASSIFIED ADS FILE: | ------------------------ | An option within KT-FleaMarket is [D]ownload Ads List. New with | version 2.12+ is the Dynamic Building of the Classified Ads file | while the user waits. This ensures the user always has the latest | greatest listing of the ads in your system. | | You can create this file in Local Mode if you wish, but you'll | "simulate" a download. | | If someone on another node is busy either building the file or | downloading it, the download option will tell the user what's going | on and ask them if they want to wait. You can't go changing a file | when it's in the process of being sent to someone else. So for that | reason, no two people can download the Classified Ads file at the | same time. | | KT-FleaMarket currently support PKZip and LHA, which are the most | popular on BBS's today. If you have a need for another archive | method, please let me know and I'll add support. | | Also, PKZIP or LHA MUST be in your path somewhere. That's pretty | likely on most BBS's these days. | Certain people may not want their ads to be included in the Download file. If this is the case, they will be prompted whether to include it or not when Adding/Editing. You can also change this value if you're using KTFMEditor. KTFMEditor ---------- If you'd like more control over the editing of the Database, call our BBS and download KTFMED10.ZIP. This is a full featured Database Editor for use with KT-FleaMarket v2.xx. It makes the archive too big to simply throw it in with the KT-FleaMarket System...sorry... WHAT THE USER NEEDS ------------------- At this time, KT-FleaMarket only supports ANSI users. We have plans to support "non-ANSI" users in the future..but..this day in age, most users have the ability to support ANSI and this shouldn't be too much of a problem for you. Please leave us comments on this subject. WHAT YOU CAN DO WHILE A USER IS ON-LINE --------------------------------------- While a user is logged on to KT-FleaMarket, you have two options available. F8 - Eject the user and send 'em back to the BBS. F10 - Chat with the user. Note: The CHAT feature is quite unique compared to other Chat Functions you've probably seen. It creates a window on the screen which allows all the arrow keys to be used (without doorway mode!). At this time, there is no word-wrapping, so you'll have to pay attention to what you're typing. I'm working on it though... TECHNICAL STUFF --------------- * You must, at a minimum, have the files and buffers set at: FILES = 40 BUFFERS = 30 | ┌───────────────────────────────────────────────────────┐ | │ YOU MUST SET THE ATTRIBUTE OF KTFLEA.EXE TO READ-ONLY │ | │ IF USED UNDER A MULTI-TASKING ENVIRONMENT!!! │ | └───────────────────────────────────────────────────────┘ | * KT-FleaMarket v2.13ß's EXE Load Image Size is 306k. * KT-FleaMarket uses interal Dynamic Overlays- please don't try to compress the EXE file with PKLite or LZE or any other EXE Compression Program, it simply won't work. * KT-FleaMarket has a built-in VMM (Virtual Memory Manager). The system will use all available extended memory up to 8 Meg. If none is available, it will resort to Disk Swapping in the current directory. * KT-FleaMarket was developed in Clipper v5.01a using the Telepathy Communications Library and ClipDoor routines. CREDITS ------- Thanks to Tammy, Kelsey, and Lindsey for their support over the past six years. An Extra Special thanks to Kelsey (for the name). A special thanks to Wayne Masters from Potpourri BBS for all the beta test support. Thanx Wayne!!! A special thanks to Chip North from The Source BBS for all the beta test support. Thanx Chip!!! Thanx to the following for providing feedback for improvements: Bruce Hussey of Toronto, Canada Jim Hill of Lompoc, CA (The Royal Wolf BBS!) John Miller of LosGatos, CA (CIE) Steven Kling of Marshall, VA (Technopesant's ][/ClipDoor) Steven Kling for ClipDoor (what a lifesaver!) Extrasensory Software for Telepathy (wouldn't be possible without it) Some names may be used in this manual which are trademarks or registered trademarks of their respective owners. MODIFICATIONS ------------- In the past month I've received over one hundred calls asking for special mod's to the KT-FleaMarket system. I'll go ahead and address that now. YES. I can make any modifications to the system that you may require. The modification fee is $25.00 / hr (minimum of one hour). If you are interested in a 'special' KT-FleaMarket system, please contact me at the numbers above to discuss your special needs. 99% of the mods I've made to the system haven't been more than $25.00. REGISTRATION/LICENSE -------------------- KT-FleaMarket is not public domain, but Shareware. You are granted a limited license to operate this program for a test period of 30 days. Completing this test period, if you decide to continue its use, you must register. The registration fee is $30.00. Georgia residents add 6% sales tax. The registration fee of $30.00 is for ONE copy of KT-FleaMarket which may be run on multiple NODES. If however, you wish to run multiple COPIES of KT-FleaMarket, you must purchase a 'site' license for $60.00. If you are interested in purchasing a site license, please call. For more information on how to register, please print out the file REGISTER.FRM. ╔══════════════════════════════════════════════════════════════════╗ ║ !!! KT-FleaMarket IS NOT CRIPPLED !!! ║ ║ ║ ║By registering KT-FleaMarket you will encourage myself and other ║ ║shareware authors to continue to provide you with quality software║ ║at the most reasonable prices. After registration, your BBS name ║ ║will appear on the opening and closing screens and remove that ║ ║annoying delay and big bold message telling everyone that you ║ ║haven't registered the software (whew, what a mouthful..) . Other ║ ║than that, you have in your hands a fully functional KT-FleaMarket║ ║system. I DON'T BELIEVE IN CRIPPLEWARE, HELP ME KEEP IT THAT WAY! ║ ╚══════════════════════════════════════════════════════════════════╝ COMMENTS PLEASE! ---------------- Please place the UNREGISTERED VERSION of this program in your communications program download area for others to evaluate. Your comments on this program are most appreciated (and encouraged). Please call our BBS and leave comments, the number is (912) 882-3588 1200-14400 / 24 hrs. Your comments could very well be what everyone else wants also, please don't be shy! What does the future hold? You tell me! DISCLAIMER/PROBLEMS/WARRANTY ---------------------------- This program is distributed as is. We guarantee that this program and its associated files will do nothing more than take up disk space on your computer! There is NO warranty! Should something go wrong, a file will be created in the KT-FleaMarket directory called ERROR.LOG. This will be very helpful to us to determine what went wrong, should you have any problems. Please communicate any problems with us through the Kelsey Technologies Support BBS at (912) 882-3588. Any problems received will be treated as high priority.